format safety doc of Rc/Arc::from_raw/from_raw_in#154081
format safety doc of Rc/Arc::from_raw/from_raw_in#154081hxuhack wants to merge 1 commit intorust-lang:mainfrom
Conversation
rustbot
added
S-waiting-on-review
|
rustbot has assigned @Mark-Simulacrum. Use Why was this reviewer chosen?The reviewer was selected based on:
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
| /// | ||
| /// * Creating a `Rc<T>` from a pointer other than one returned from | ||
| /// [`Rc<U>::into_raw`][into_raw] or [`Rc<U>::into_raw_with_allocator`][into_raw_with_allocator] | ||
| /// is undefined behavior. |
There was a problem hiding this comment.
I'm guessing it is also undefined behavior if the pointer came from a call to into_raw_with_allocator where the returned allocator was not the global one.
There was a problem hiding this comment.
Yes, but there is another safety requirement in the safety section preventing this: the raw pointer must point to a block of memory allocated by the global allocator.
| /// | ||
| /// The raw pointer must have been previously returned by a call to | ||
| /// [`Rc<U>::into_raw`][into_raw] with the following requirements: | ||
| /// [`Rc<U>::into_raw`][into_raw] or [`Rc<U>::into_raw_with_allocator`][into_raw_with_allocator]. |
There was a problem hiding this comment.
This information is now duplicated in the safety section, but there it is phrased negatively instead. Should perhaps this positive version be moved into the safety section instead?
There was a problem hiding this comment.
I referred to the format used in Thread::from_raw, which follows the same pattern.
5 participants
The following APIs previously had safety notes, but they were not placed under a dedicated Safety section. This PR adds a Safety section for each API and moves the original safety descriptions there:
Rc::from_rawRc::from_raw_inArc::from_rawArc::from_raw_inAdditionally, we updated the parameter requirements to clarify that the raw pointer may be returned not only from
into_raw, but also frominto_raw_with_allocator.